PinningApi
All URIs are relative to **
| Method | HTTP request | Description |
|---|---|---|
| pinningPinsGet | GET /pinning/pins | List all pin status objects |
| pinningPinsPinidDelete | DELETE /pinning/pins/{pinid} | Delete a pinned object |
| pinningPinsPinidGet | GET /pinning/pins/{pinid} | Get a pin status object |
| pinningPinsPinidPost | POST /pinning/pins/{pinid} | Replace a pinned object |
| pinningPinsPost | POST /pinning/pins | Add and pin object |
pinningPinsGet
List all pin status objects
This endpoint lists all pin status objects
Example
pinningPinsGet
Parameters
This endpoint does not need any parameter.
Return type
(empty response body)
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
pinningPinsPinidDelete
Delete a pinned object
This endpoint deletes a pinned object.
Example
pinningPinsPinidDelete pinid=value
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| pinid | string | Pin ID |
Return type
(empty response body)
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
pinningPinsPinidGet
Get a pin status object
This endpoint returns a pin status object.
Example
pinningPinsPinidGet pinid=value
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| pinid | string | cid |
Return type
(empty response body)
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
pinningPinsPinidPost
Replace a pinned object
This endpoint replaces a pinned object.
Example
pinningPinsPinidPost pinid=value
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| pinid | string | Pin ID |
Return type
(empty response body)
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
pinningPinsPost
Add and pin object
This endpoint adds a pin to the IPFS daemon.
Example
pinningPinsPost cid=value name=value
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| cid | string | cid | |
| name | string | name |
Return type
(empty response body)
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]